home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / tools / wb-enhancement / thechoice / thechoice.readme < prev    next >
Text File  |  1996-02-26  |  12KB  |  311 lines
  1. Short:        TheChoice V2.13 - Simple Program Selector
  2. Author:       c_wich@river.prima.ruhr.de (Carsten Wich)
  3. Uploader:     c_wich@river.prima.ruhr.de (Carsten Wich)
  4. Type:         util/boot
  5.  
  6.                              ===================
  7.                              = TheChoice V2.13 =
  8.                              ===================
  9.                              Release: 21.01.1996
  10.                               Copyright 1993-96
  11.                                      by
  12.                                 Carsten Wich
  13.                                Hagebuttenweg 34
  14.                                D-44289 Dortmund
  15.                                    Germany
  16.                             Phone: +49-2304-43692
  17.                       E-Mail: c_wich@river.prima.ruhr.de
  18.  
  19.                          Bank Account No. 315 1048 400
  20.                                 BLZ 441 600 14
  21.                               Volksbank Dortmund
  22.  
  23.  
  24. INTRODUCTION
  25. ============
  26.  
  27. The Choice is a small Program Selector especially useful for Game Partitions
  28. on Harddisks, SyQuests or even CD-ROMs.
  29. I first wrote it in Modula2 (M2Amiga) because I just found no simple program
  30. selector that fully suits my needs. Although the first version of it worked
  31. good enought for me, some of my friends liked the program very much and made
  32. some proposals for future versions. I switched to SAS-C because the support
  33. for M2Amiga is not that good anymore. Especially the lack of actual includes
  34. for OS3.1 really bothered me. I have completly rewritten the code in the C
  35. programming language and made a lot of improvements.
  36. TheChoice runs on every possible screenmode, even on graphic cards !
  37.  
  38.  
  39. LEAGAL THINKS
  40. =============
  41.  
  42. TheChoice Copyright (c) 1993-1996 Carsten Wich can be freely distributed,
  43. as long as the whole archive 'TheChoice2.lha' is copied and all of the
  44. files are in their original form without any changes.
  45. Upload to BBS's and includions on any cover disks or CD's is WELCOMED.
  46. This software is published without any warranties. The author does NOT take
  47. any responsibilities for any defects on soft- or hardware, that may result
  48. by this program or by using this program.
  49. I have tried to write the program code according to the AMIGA User Interface
  50. Style Guide and the AMIGA ROM Kernel Reference Manuals V2.04 so that the
  51. program should run correctly on any future operating systems. It is also
  52. tested with Enforcer.
  53. Although this program may be freely distibuted and used it would be very nice
  54. of the people who permanently use it to send me a small fee (I would say at
  55. 15,- DM or $10,- US) as a little acknowledgement for my work. You can send
  56. it cash, as a EuroCheque or via a Bank Transfer on my Bank Account.
  57. This would naturally increase my motivation to develop the program even
  58. further.
  59.  
  60.  
  61. SYSTEMREQUIREMENTS
  62. ==================
  63.  
  64. The program only needs a minimal Amiga System :
  65.  
  66.   - Any Amiga with at least 512 KB RAM
  67.   - min. OS 2.04
  68.   - diskfont.library min. V36 when you want to select another font than the
  69.     default one
  70.  
  71.  
  72. DEVELOPMENT ENVIRONMENT
  73. =======================
  74.  
  75. Hardware :
  76.  
  77.   - Amiga 2000C Big Tower with ECS Chipset (2MB Chip RAM)
  78.   - GForce 030 50MHz with 12MB 32Bit RAM
  79.   - GVP EGS 28/24 LC
  80.   - GVP I/O Extender
  81.   - NEC 3D
  82.   - Toshiba MK-537 1GB HD
  83.   - Toshiba XM-3401TA  CD-ROM
  84.   - HP-38470A DAT Streamer
  85.   - ZyXEL Elite 2864D
  86.  
  87. Software :
  88.  
  89.   - Kickstart V40.63 ROM
  90.   - Workbench V40.42
  91.   - CyberGraphX V2.14reg
  92.   - SAS-C V6.56
  93.   - GoldEd V3.1.3 reg.
  94.   - Enforcer / Mungwall / Sushi
  95.   - Diavolo Backup V3.2 (Yeah, the best backup program around)
  96.   - DOpus 5.11d
  97.  
  98.  
  99. HOW IT WORKS
  100. ============
  101.  
  102. TheChoice opens its window on the default public screen (or one that you
  103. specify) and displays an Intuition gadget for every program that you can
  104. choose from.
  105. The window which is opened by TheChoice always covers the whole screen, no
  106. matter how many script entries the config file has.
  107. If there are more script entries than the maximum number of gadgets the
  108. window can hold, TheChoice stops reading the config file and uses this
  109. maximum number of programs only. If you want to display more selections
  110. increase the resolution of the screen or decrease the size of the font.
  111. Future version will hopefully have the possibility to select different
  112. pages.
  113. The program to be executed can easily be selected by a left mouse click.
  114. That's all ! Nothing more and nothing less. (Sounds quite simple, eh ?) 8-)
  115. If you don't want to execute any program just activate the Close gadget or
  116. press the ESC key.
  117.  
  118.  
  119. INSTALLATION
  120. ============
  121.  
  122. Installation is quite simple. Just place TheChoice in a path of your choice
  123. and create a config file (normally called 'TheChoice.config' in the same
  124. path as the main program).
  125. You can of course use the one that came with the distribution archive and
  126. alter that one.
  127.  
  128.  
  129. CONFIGURATION
  130. =============
  131.  
  132. All configuration of TheChoice other than that for the programs to be
  133. executed is made through shell arguments or tooltypes. They both have the
  134. same syntax so I only have to describe them once. Entering "TheChoice ?"
  135. from CLI gives you the template for the shell options (and some abbrevia-
  136. tions for them).
  137.  
  138.   CONFIGFILE   : Here you can set the path and the name of the config file
  139.                  TheChoice should use.
  140.                  Defaults simply to 'TheChoice.config'.
  141.                  Note: You must not specify the keyword CONFIGFILE when
  142.                        starting TheChoice from shell.
  143.  
  144.   PUBSCREEN    : Here you can specify the name of an already open public
  145.                  screen on that TheChoice should open its window.
  146.                  Defaults to the default public screen (normally the Work-
  147.                  bench screen or the initial CLI startup screen).
  148.  
  149.   MODEID       : TheChoice tries to open its own screen when you set this
  150.                  option to a valid screenmode ID.
  151.                  Defaults to none.
  152.  
  153.   ONEBITPLANE  : This option is only effective when you also set the MODEID
  154.                  option. When set TheChoice opens its own screen using only
  155.                  one bitplane. This is useful if you are short of memory.
  156.  
  157.   FONTNAME &     
  158.   FONTHEIGHT   : Here you can specify the font TheChoice uses for the gadget
  159.                  texts. The font that is used for the window topborder is
  160.                  always the default font for that screen.
  161.                  You have to specify both options, e.g. FONTNAME=topaz.font
  162.                  and FONTHEIGHT=8.
  163.                  If not set TheChoice uses the screens default font for
  164.                  windows.
  165.  
  166.   BORDERLESS   : When you specify this option TheChoice opens it window in
  167.                  an borderless mode, so no borders are drawn by intuition
  168.                  around the window.
  169.  
  170.   MAXGADLEN    : Here you can specify the maximum character length that can
  171.                  be used for the gadgets. This option has an effect on how
  172.                  many gadget can be put in a window.
  173.                  Defaults to 24.
  174.  
  175.   MAXSCRIPTLEN : With this option you can set the maximum length of the
  176.                  script name (!) that is associated with the program name.
  177.                  This option has an effect for the size of the memory that
  178.                  is used for storing these names.
  179.                  Defaults to 40.
  180.  
  181.   EXESCRIPT    : Normally TheChoice executes the script that is associated
  182.                  with the chosen program directly. That has the disadvantage
  183.                  that not all resources are freed before program execution.
  184.                  When you set this option TheChoice copies the name of the
  185.                  script that has to be executed in order to run the selected
  186.                  program in a file 'RAM:script'. This file has to be executed
  187.                  after TheChoice has terminated.
  188.                  Example startup script :
  189.  
  190.                    ...
  191.                    TheChoice
  192.                    Avail >NIL: Flush
  193.                    Execute RAM:script
  194.                    EndCli
  195.  
  196.                  Default is direct execution.
  197.  
  198.  
  199. CONFIG-FILE
  200. ===========
  201.  
  202. From Release 2.00 on the configfile can be located anywhere and can be named
  203. freely. It is not limited to 'S:TheChoice.config' anymore.
  204.  
  205. The Contents of the config file breaks down as follows :
  206.  
  207.   <Name of Program 1>
  208.   <executable script for Program 1>
  209.   <Name of Program 2>
  210.   <executable script for Program 2>
  211.   <Name of Program 3>
  212.   <executable script for Program 3>
  213.   .
  214.   .
  215.   .
  216.   .
  217.   <Name of Program xxx>
  218.   <executable script for Program xxx>
  219.  
  220. The <Name of Program> Text appears in the Gadget and the <executable script for
  221. Program> will be executed after selection of the appropiate gadget.
  222.  
  223. That's basically all you have to know (Quite simply, eh).
  224.  
  225. New in 2.10: When the executable script entry has the form
  226.  
  227.   "CONFIG=<name of the new configfile>"
  228.  
  229. the new configfile will be read in and the display changes to the new setup.
  230. This feature allows the user to create menu trees.
  231.  
  232.  
  233. THANKS TO
  234. =========
  235.  
  236.   - Christoph Stoppe for encouraging me to develop this little program further.
  237.  
  238.  
  239. WHAT CAN YOU DO
  240. ===============
  241.  
  242. If you have any proposals or find any bugs then let me know. I would also like
  243. to hear some opinions about this little program so that I can see if there is a
  244. need in the Amiga World for it or if I should waste my time on something other.
  245.  
  246.  
  247. HISTORY
  248. =======
  249.  
  250. 2.13 - 21.01.1996 - Fourth AmiNet Release
  251.      - Bugfix: TheChoice crashed if a new configfile could not be read in for
  252.        some reason
  253.  
  254. 2.12 - 20.01.1996 - Third AmiNet Release
  255.      - Renamed the RAMSCRIPT Tooltype and shell argument to SCRIPT
  256.      - some more code optimization resulting in the executable beeing about
  257.        7K (!) smaller
  258.      - TheChoice now returns errorcodes to the calling environment
  259.  
  260. 2.11 - 16.01.1996 - internal beta version
  261.      - some code optimization resulting in the executable being 150 bytes
  262.        smaller
  263.  
  264. 2.10 - 16.01.1996 - internal beta version
  265.      - compiled with SAS-C V6.56
  266.      - some code cleanup
  267.      - added the possibility to read in a new config file
  268.  
  269. 2.00 - 14.10.1995 - Second AmiNet Release
  270.      - Completly rewritten in SAS-C V6.55
  271.      - Runs on any screenmode using any font.
  272.      - The maximum number of programs / gadgets now depends on the chosen screen
  273.        mode and font.
  274.      - Can be configured using shell arguments or tooltypes.
  275.      - Supports borderless windows and onebitplane screens.
  276.      - No source code made publically available anymore.
  277.  
  278. 1.05 - 27.07.1995 - First AmiNet Release
  279.      - Removed some beta code so the executable is now a bit shorter
  280.      - Removed the switch between PAL and NTSC because NTSC is not supported in
  281.        this release
  282.      - TheChoice excutes the script again (due to some complaints by a friend of
  283.        mine
  284.  
  285. 1.04 - still beta, but several bug fixes and improvements...
  286.      - only PAL screen possible -> more max entries possible
  287.      - TheChoice now searches for the config script in S: rather than in Games:S
  288.      - TheChoice now copies the choosen script to the file "RAM:Script" which
  289.        you have to execute after you started TheChoice
  290.  
  291. 1.02-
  292. 1.03 - internal beta versions
  293.  
  294. 1.01 - 13.03.1994 - Bugfixed Release
  295.      - TheChoice crashed if the Config-File had more than 77 Programs
  296.  
  297. 1.0  - 23.11.1993 - First Release
  298.  
  299.  
  300. POSSIBLE FUTURE IMPROVEMENTS
  301. ============================
  302.  
  303.  - Use different pages so you can choose between more programs even on small
  304.    screens.
  305.  - Selection with a joystick and / or cursor keys (You can already use the left
  306.    Amiga key together with the cursor keys to move the mouse pointer and the
  307.    left mouse button can be simulated by pressing left Alt and left Amiga keys).
  308.  
  309. So long, tramps like us...
  310.  
  311.